Initial version of the OpenKlant2 client #1381

swrichards · 2024-09-04T13:01:23Z

No description provided.

pi-sigma

General question: why are we building the version into the package name? Is this provisional?

src/openklant2/_resources/base.py

src/openklant2/_resources/partij.py

pi-sigma · 2024-09-04T13:32:10Z

src/openklant2/_resources/partij.py

+        return cast(PaginatedResponseBody[Partij], self.process_response(response))
+
+    def retrieve(
+        self, /, uuid: str | uuid.UUID, *, params: Optional[PartijRetrieveParams] = None


This is the only method (at least in this class) where you explicitly mark positional-only arguments as such.

This was by design: I wanted the path parameters to be positional only, to distinguish them from the other kind of parameters. The idea is that all path parameters would then appear in sequence as positional-only args.

src/openklant2/_resources/partij.py

src/openklant2/tests/helpers.py

src/openklant2/tests/test_partij.py

pi-sigma · 2024-09-04T14:26:34Z

src/openklant2/tests/test_partij.py

+
+
+@pytest.fixture()
+def an_organisatie(client):


See previous comment

src/openklant2/tests/test_partij.py

pi-sigma · 2024-09-04T14:37:26Z

src/openklant2/types/resources/partij.py

+    rekeningnummers: Required[list[ForeignKeyRef] | None]
+    voorkeursRekeningnummer: Required[ForeignKeyRef | None]
+
+    voorkeurstaal: LanguageCode


I thought the distinction between Required and NotRequired is exhaustive, but this is neither (same for the attributes below)?

We need Required mainly when we want to indicate "The key should be present, but it can be optionally None", as above for e.g. voorkeursRekeningnummer. If the field is required and not a union, no explicit Required is needed I believe.

src/openklant2/types/resources/partij.py

codecov-commenter · 2024-09-04T15:08:06Z

Codecov Report

Attention: Patch coverage is 76.68394% with 135 lines in your changes missing coverage. Please review.

Project coverage is 94.96%. Comparing base (af6f72b) to head (2a3881d).

Files with missing lines	Patch %	Lines
src/openklant2/_resources/base.py	35.93%	41 Missing ⚠️
src/openklant2/tests/test_partij.py	50.00%	28 Missing ⚠️
src/openklant2/exceptions.py	64.70%	18 Missing ⚠️
src/openklant2/tests/test_digitaal_adres.py	62.06%	11 Missing ⚠️
src/openklant2/tests/test_partij_identificator.py	59.25%	11 Missing ⚠️
src/openklant2/_resources/partij.py	62.50%	9 Missing ⚠️
src/openklant2/_resources/digitaal_adres.py	66.66%	6 Missing ⚠️
src/openklant2/_resources/partij_identificator.py	66.66%	6 Missing ⚠️
src/openklant2/client.py	66.66%	4 Missing ⚠️
src/openklant2/factories/helpers.py	90.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1381      +/-   ##
===========================================
- Coverage    95.25%   94.96%   -0.29%     
===========================================
  Files         1008     1032      +24     
  Lines        37370    37949     +579     
===========================================
+ Hits         35595    36039     +444     
- Misses        1775     1910     +135

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

swrichards · 2024-09-05T09:49:53Z

General question: why are we building the version into the package name? Is this provisional?

The thinking here is that we already have an'openklant client, and generally that OpenKlant 2 is not simply a continuation of <2, but effectively an entirely different API. But we can check with @alextreme if he agrees with the naming strategy.

swrichards · 2024-09-05T12:27:42Z

Leaving this in draft for the moment: I have moved on to the implementation and am finding some missing params in the Partij resource, I'll add them to this PR.

swrichards · 2024-09-12T12:52:40Z

Leaving this in draft for the moment: I have moved on to the implementation and am finding some missing params in the Partij resource, I'll add them to this PR.

@pi-sigma Some more changes prompted by #1396 (which will follow this PR).

pi-sigma

Looks good, couple minor suggestions

src/openklant2/exceptions.py

src/openklant2/tests/helpers.py

src/openklant2/tests/test_partij.py

src/openklant2/tests/test_partij_identificator.py

swrichards force-pushed the tasks/2735-openklant-api-client branch 12 times, most recently from ff17d65 to 01d0d7d Compare September 4, 2024 14:41

pi-sigma requested changes Sep 4, 2024

View reviewed changes

pi-sigma reviewed Sep 4, 2024

View reviewed changes

src/openklant2/types/resources/partij.py Show resolved Hide resolved

swrichards force-pushed the tasks/2735-openklant-api-client branch from 01d0d7d to 78de82f Compare September 5, 2024 09:47

swrichards force-pushed the tasks/2735-openklant-api-client branch 2 times, most recently from 95851e1 to 8b23d82 Compare September 5, 2024 10:43

swrichards marked this pull request as ready for review September 5, 2024 10:47

swrichards requested a review from pi-sigma September 5, 2024 10:47

pi-sigma approved these changes Sep 5, 2024

View reviewed changes

swrichards marked this pull request as draft September 5, 2024 12:27

Add testing dependencies for openklant2 client

757943c

swrichards force-pushed the tasks/2735-openklant-api-client branch from 8b23d82 to e589b57 Compare September 12, 2024 12:32

swrichards marked this pull request as ready for review September 12, 2024 12:51

swrichards requested a review from pi-sigma September 12, 2024 12:52

pi-sigma requested changes Sep 12, 2024

View reviewed changes

swrichards added 2 commits September 12, 2024 16:21

Initial version of the OpenKlant2 client

f96f6ac

Run openklant client tests in CI

2a3881d

swrichards force-pushed the tasks/2735-openklant-api-client branch from e589b57 to 2a3881d Compare September 12, 2024 14:21

swrichards requested a review from pi-sigma September 12, 2024 14:37

pi-sigma approved these changes Sep 12, 2024

View reviewed changes

alextreme merged commit 4bc9462 into develop Sep 12, 2024
22 checks passed

alextreme deleted the tasks/2735-openklant-api-client branch September 12, 2024 15:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial version of the OpenKlant2 client #1381

Initial version of the OpenKlant2 client #1381

swrichards commented Sep 4, 2024

pi-sigma left a comment

pi-sigma Sep 4, 2024

swrichards Sep 5, 2024

pi-sigma Sep 4, 2024

pi-sigma Sep 4, 2024

swrichards Sep 5, 2024

codecov-commenter commented Sep 4, 2024 •

edited

Loading

swrichards commented Sep 5, 2024

swrichards commented Sep 5, 2024

swrichards commented Sep 12, 2024

pi-sigma left a comment

Initial version of the OpenKlant2 client #1381

Initial version of the OpenKlant2 client #1381

Conversation

swrichards commented Sep 4, 2024

pi-sigma left a comment

Choose a reason for hiding this comment

pi-sigma Sep 4, 2024

Choose a reason for hiding this comment

swrichards Sep 5, 2024

Choose a reason for hiding this comment

pi-sigma Sep 4, 2024

Choose a reason for hiding this comment

pi-sigma Sep 4, 2024

Choose a reason for hiding this comment

swrichards Sep 5, 2024

Choose a reason for hiding this comment

codecov-commenter commented Sep 4, 2024 • edited Loading

Codecov Report

swrichards commented Sep 5, 2024

swrichards commented Sep 5, 2024

swrichards commented Sep 12, 2024

pi-sigma left a comment

Choose a reason for hiding this comment

codecov-commenter commented Sep 4, 2024 •

edited

Loading